<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PIAdapters</name>
    </assembly>
    <members>
        <member name="T:PIAdapters.PIConnection">
            <summary>
            Represents a connection to a PI server that handles open, close and executes operations.
            </summary>
        </member>
        <member name="F:PIAdapters.PIConnection.DefaultConnectTimeout">
            <summary>
            Default value for <see cref="P:PIAdapters.PIConnection.ConnectTimeout"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnection.#ctor">
            <summary>
            Creates a new OSI-PI connection.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnection.Dispose">
            <summary>
            Releases all the resources used by the <see cref="T:PIAdapters.PIConnection"/> object.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnection.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by the <see cref="T:PIAdapters.PIConnection"/> object and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:PIAdapters.PIConnection.Open">
            <summary>
            Attempts to open <see cref="T:PIAdapters.PIConnection"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnection.Close">
            <summary>
            Closes <see cref="T:PIAdapters.PIConnection"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnection.CompareTo(PIAdapters.PIConnection)">
            <summary>
            Compares the current object with another object of the same type.
            </summary>
            <returns>
            A value that indicates the relative order of the objects being compared. The return value has the following meanings: 
            Value Meaning Less than zero This object is less than the <paramref name="other"/> parameter.
            Zero This object is equal to <paramref name="other"/>.
            Greater than zero This object is greater than <paramref name="other"/>. 
            </returns>
            <param name="other">An object to compare with this object.</param>
        </member>
        <member name="E:PIAdapters.PIConnection.Disconnected">
            <summary>
            Raised when <see cref="T:PIAdapters.PIConnection"/> has been disconnected from server.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.Server">
            <summary>
            Gets PI server object for this PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.ServerName">
            <summary>
            Gets or sets the name of the PI server for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.UserName">
            <summary>
            Gets or sets the name of the PI user ID for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.Password">
            <summary>
            Gets or sets the password used for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.ConnectTimeout">
            <summary>
            Gets or sets the timeout interval (in milliseconds) for the adapter's connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnection.Connected">
            <summary>
            Gets flag that determines if <see cref="T:PIAdapters.PIConnection"/> is currently connected to <see cref="P:PIAdapters.PIConnection.ServerName"/>.
            </summary>
        </member>
        <member name="T:PIAdapters.PIConnectionPool">
            <summary>
            Represents a pool of <see cref="T:PIAdapters.PIConnection"/> instances.
            </summary>
        </member>
        <member name="F:PIAdapters.PIConnectionPool.DefaultAccessCountPerConnection">
            <summary>
            Default value for <see cref="P:PIAdapters.PIConnectionPool.AccessCountPerConnection"/>.
            </summary>
        </member>
        <member name="F:PIAdapters.PIConnectionPool.DefaultMinimumPoolSize">
            <summary>
            Default value for <see cref="P:PIAdapters.PIConnectionPool.MinimumPoolSize"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.#ctor">
            <summary>
            Creates a new <see cref="T:PIAdapters.PIConnectionPool"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.#ctor(System.Int32)">
            <summary>
            Creates a new <see cref="T:PIAdapters.PIConnectionPool"/>.
            </summary>
            <param name="minimumPoolSize">Minimum pool size to maintain.</param>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.Finalize">
            <summary>
            Releases the unmanaged resources before the <see cref="T:PIAdapters.PIConnectionPool"/> object is reclaimed by <see cref="T:System.GC"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.Dispose">
            <summary>
            Releases all the resources used by the <see cref="T:PIAdapters.PIConnectionPool"/> object.
            </summary>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by the <see cref="T:PIAdapters.PIConnectionPool"/> object and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.GetPooledConnection(System.String,System.String,System.String,System.Int32)">
            <summary>
            Gets a connection from the pool or creates a new one if all current connections are being used at peak access.
            </summary>
            <param name="serverName">Name of the PI server for the adapter's PI connection.</param>
            <param name="userName">Name of the PI user ID for the adapter's PI connection.</param>
            <param name="password">Password used for the adapter's PI connection.</param>
            <param name="connectTimeout">Timeout interval (in milliseconds) for the adapter's connection.</param>
            <returns>A <see cref="T:PIAdapters.PIConnection"/> from the pool.</returns>
            <exception cref="T:System.InvalidOperationException">Failed to get a pooled PI connection.</exception>
        </member>
        <member name="M:PIAdapters.PIConnectionPool.ReturnPooledConnection(PIAdapters.PIConnection)">
            <summary>
            Returns <see cref="T:PIAdapters.PIConnection"/> to the pool.
            </summary>
            <param name="connection"><see cref="T:PIAdapters.PIConnection"/> to return to the pool.</param>
            <exception cref="T:System.InvalidOperationException">Provided PIConnection does not belong to this connection pool.</exception>
        </member>
        <member name="E:PIAdapters.PIConnectionPool.Disconnected">
            <summary>
            Raised when a <see cref="T:PIAdapters.PIConnection"/> has been disconnected from server.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnectionPool.MinimumPoolSize">
            <summary>
            Gets minimum pool size for the <see cref="T:PIAdapters.PIConnectionPool"/>.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnectionPool.AccessCountPerConnection">
            <summary>
            Gets or sets maximum accessibility count for each <see cref="T:PIAdapters.PIConnection"/>.
            </summary>
        </member>
        <member name="P:PIAdapters.PIConnectionPool.Size">
            <summary>
            Gets current size of connection pool.
            </summary>
        </member>
        <member name="T:PIAdapters.PIOutputAdapter">
            <summary>
            Exports measurements to PI if the point tag or alternate tag corresponds to a PI point's tag name.
            </summary>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.#ctor">
            <summary>
            Creates a new <see cref="T:PIAdapters.PIOutputAdapter"/>
            </summary>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by the <see cref="T:PIAdapters.PIOutputAdapter"/> object and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Returns a brief status of this <see cref="T:PIAdapters.PIOutputAdapter"/>
            </summary>
            <param name="maxLength">Maximum number of characters in the status string</param>
            <returns>Status</returns>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:PIAdapters.PIOutputAdapter"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.AttemptConnection">
            <summary>
            Connects to the configured PI server.
            </summary>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.AttemptDisconnection">
            <summary>
            Closes this <see cref="T:PIAdapters.PIOutputAdapter"/> connections to the PI server.
            </summary>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.ProcessMeasurements(GSF.TimeSeries.IMeasurement[])">
            <summary>
            Sorts measurements and sends them to the configured PI server in batches
            </summary>
            <param name="measurements">Measurements to queue</param>
        </member>
        <member name="M:PIAdapters.PIOutputAdapter.ExecuteMetadataRefresh">
            <summary>
            Sends updated metadata to PI.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.OutputIsForArchive">
            <summary>
            Returns true to indicate that this <see cref="T:PIAdapters.PIOutputAdapter"/> is sending measurements to a historian, OSISoft PI.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.UseAsyncConnect">
            <summary>
            Returns false to indicate that this <see cref="T:PIAdapters.PIOutputAdapter"/> will connect synchronously
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.ServerName">
            <summary>
            Gets or sets the name of the PI server for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.UserName">
            <summary>
            Gets or sets the name of the PI user ID for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.Password">
            <summary>
            Gets or sets the password used for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.ConnectTimeout">
            <summary>
            Gets or sets the timeout interval (in milliseconds) for the adapter's connection
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.RunMetadataSync">
            <summary>
            Gets or sets whether or not this adapter should automatically manage metadata for PI points.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.TagNamePrefixRemoveCount">
            <summary>
            Gets or sets the number of tag name prefixes, e.g., "SOURCE!", applied by subscriptions to remove from PI tag names.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.PIPointSource">
            <summary>
            Gets or sets the point source string used when automatically creating new PI points during the metadata update
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.PIPointClass">
            <summary>
            Gets or sets the point class string used when automatically creating new PI points during the metadata update. On the PI server, this class should inherit from classic.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.UseCompression">
            <summary>
            Gets or sets flag that determines if defined point compression will be used during archiving.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.TagMapCacheFileName">
            <summary>
            Gets or sets the filename to be used for tag map cache.
            </summary>
        </member>
        <member name="P:PIAdapters.PIOutputAdapter.Status">
            <summary>
            Returns the detailed status of the data output source.
            </summary>
        </member>
        <member name="T:PIAdapters.PIPBInputAdapter">
            <summary>
            Retrieves historical OSI-PI data using AF-SDK.
            </summary>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.#ctor">
            <summary>
            Creates a new instance of the <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by the <see cref="T:PIAdapters.PIPBInputAdapter"/> object and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
            <exception cref="T:System.ArgumentException"><b>HistorianID</b>, <b>Server</b>, <b>Port</b>, <b>Protocol</b>, or <b>InitiateConnection</b> is missing from the <see cref="P:GSF.TimeSeries.Adapters.AdapterBase.Settings"/>.</exception>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Gets a short one-line status of this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
            <param name="maxLength">Maximum length of the status message.</param>
            <returns>Text of the status message.</returns>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.AttemptConnection">
            <summary>
            Attempts to connect to this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
        </member>
        <member name="M:PIAdapters.PIPBInputAdapter.AttemptDisconnection">
            <summary>
            Attempts to disconnect from this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.InstanceName">
            <summary>
            Gets or sets instance name defined for this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.ServerName">
            <summary>
            Gets or sets the name of the PI server for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.UserName">
            <summary>
            Gets or sets the name of the PI user ID for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.Password">
            <summary>
            Gets or sets the password used for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.ConnectTimeout">
            <summary>
            Gets or sets the timeout interval (in milliseconds) for the adapter's connection
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.PublicationInterval">
            <summary>
            Gets or sets the publication interval for this <see cref="T:PIAdapters.PIPBInputAdapter"/>.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.StartTimeConstraint">
            <summary>
            Gets the start time for reading data.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.StopTimeConstraint">
            <summary>
            Gets the stop time for reading data.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.SimulateTimestamp">
            <summary>
            Gets or sets a value that determines whether timestamps are
            simulated for the purposes of real-time concentration.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.AutoRepeat">
            <summary>
            Gets or sets value that determines if the input data should be replayed repeatedly.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.SupportsTemporalProcessing">
            <summary>
            Gets the flag indicating if this adapter supports temporal processing.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.ProcessingInterval">
            <summary>
            Gets or sets the desired processing interval, in milliseconds, for the adapter.
            </summary>
            <remarks>
            With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
            basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
            interval while a value of 0 means to process data as fast as possible.
            </remarks>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.UseAsyncConnect">
            <summary>
            Gets flag that determines if this <see cref="T:PIAdapters.PIPBInputAdapter"/> uses an asynchronous connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIPBInputAdapter.Status">
            <summary>
            Returns the detailed status of the data input source.
            </summary>
        </member>
        <member name="T:PIAdapters.PIRTInputAdapter">
            <summary>
            Uses PI event pipes to deliver real-time PI data to GSF host
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.#ctor">
            <summary>
            Receives real-time updates from PI
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.Initialize">
            <summary>
            Reads values from the connection string and prepares this <see cref="T:PIAdapters.PIRTInputAdapter"/> for connecting to PI
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.AttemptConnection">
            <summary>
            Connects to the configured PI server.
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.AttemptDisconnection">
            <summary>
            Disconnects from the configured PI server if a connection is open
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Returns brief status with measurements processed
            </summary>
            <param name="maxLength"></param>
            <returns></returns>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.StartGettingData(System.Object)">
            <summary>
            Starts threads and timers to poll the PI server for data
            </summary>
            <param name="state">Filter string which will get the desired points from PI</param>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.QueryData">
            <summary>
            Runs a constant loop to pull data from PI
            </summary>
        </member>
        <member name="M:PIAdapters.PIRTInputAdapter.Dispose(System.Boolean)">
            <summary>
            Disposes members for garbage collection
            </summary>
            <param name="disposing"></param>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.UseEventPipes">
            <summary>
            Gets or sets a value for whether the adapter will use event pipes. If event pipes are disabled, the adapter will use polling.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.QueryTimeSpan">
            <summary>
            Gets or sets the number of seconds to query when the adapter is polling instead of using event pipes.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.UseAsyncConnect">
            <summary>
            Returns false to indicate that this <see cref="T:PIAdapters.PIRTInputAdapter"/> does NOT connect asynchronously
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.SupportsTemporalProcessing">
            <summary>
            Returns false to indicate that this <see cref="T:PIAdapters.PIRTInputAdapter"/> does NOT support temporal processing. 
            Temporal processing is supported in a separate adapter that is not driven by event pipes.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.RequestedOutputMeasurementKeys">
            <summary>
            Gets or sets the measurements that this <see cref="T:PIAdapters.PIRTInputAdapter"/> has been requested to provide
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.ServerName">
            <summary>
            Gets or sets the name of the PI server for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.UserName">
            <summary>
            Gets or sets the name of the PI user ID for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.Password">
            <summary>
            Gets or sets the password used for the adapter's PI connection.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.ConnectTimeout">
            <summary>
            Gets or sets the timeout interval (in milliseconds) for the adapter's connection
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.AutoAddOutput">
            <summary>
            Enables or disables adapter's ability to automatically set output measurements.
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.LastReceivedTimestamp">
            <summary>
            Last timestamp received from PI
            </summary>
        </member>
        <member name="P:PIAdapters.PIRTInputAdapter.Status">
            <summary>
            Returns the status of the adapter
            </summary>
        </member>
        <member name="T:PIAdapters.TimeSortedValueScanner">
            <summary>
            Reads a series of record values from a <see cref="T:OSIsoft.AF.PI.PIPointList"/> in time sorted order.
            </summary>
        </member>
        <member name="M:PIAdapters.TimeSortedValueScanner.Read">
            <summary>
            Reads all <see cref="T:OSIsoft.AF.Asset.AFValue"/> instances in time sorted order as a yielding enumerable.
            </summary>
            <returns>Each recorded <see cref="T:OSIsoft.AF.Asset.AFValue"/> in time-sorted order for the specified <see cref="P:PIAdapters.TimeSortedValueScanner.Points"/> and time-range.</returns>
        </member>
        <member name="P:PIAdapters.TimeSortedValueScanner.Points">
            <summary>
            Gets or sets the source points that this scanner is reading from.
            </summary>
        </member>
        <member name="P:PIAdapters.TimeSortedValueScanner.StartTime">
            <summary>
            Gets or sets the minimum value of the timestamps of the data points returned by the scanner.
            </summary>
        </member>
        <member name="P:PIAdapters.TimeSortedValueScanner.EndTime">
            <summary>
            Gets or sets the maximum value of the timestamps of the data points returned by the scanner.
            </summary>
        </member>
        <member name="P:PIAdapters.TimeSortedValueScanner.DataReadExceptionHandler">
            <summary>
            Gets or sets the handler used to manage any exceptions that may occur while reading data.
            </summary>
        </member>
    </members>
</doc>
